Docs: correct get_post_custom() return description#10996
Docs: correct get_post_custom() return description#10996meravi wants to merge 3 commits intoWordPress:trunkfrom
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
| $post_id = get_the_ID(); | ||
| } | ||
|
|
||
| return get_post_meta( $post_id ); |
There was a problem hiding this comment.
Maybe update the docs for get_post_meta() as well?
There was a problem hiding this comment.
Good point, thanks for the suggestion!
Since this ticket specifically addresses the documentation for get_post_custom(), I kept the change scoped to that function.
If it makes sense to align the get_post_meta() docs as well, I’m happy to open a follow-up patch to keep the changes focused and reviewable.
Let me know your preference 🙂
There was a problem hiding this comment.
Alright. Fine to keep it scoped to this one function.
Co-authored-by: Weston Ruter <westonruter@gmail.com>
2 participants
Trac ticket: https://core.trac.wordpress.org/ticket/60646
Summary
Updates the
get_post_custom()docblock insrc/wp-includes/post.phpto remove the incorrect claim that negative post IDs are invalid. Negative IDs are normalized viaabsint()in the function, so they should not be documented as invalid.Changes
Tested